fix: always write devcontainer.metadata label as JSON array#1199
Merged
abdurriq merged 3 commits intoApr 10, 2026
Conversation
When there is only one metadata entry (e.g. docker-compose devcontainer with no features), `getDevcontainerMetadataLabel` wrote a bare JSON object instead of an array. This violates the spec which states the label "can contain an array of json snippets" and causes tools like Zed that expect an array to fail when attaching to an existing container. Always wrap the metadata in an array regardless of the number of entries. Spec reference: https://containers.dev/implementors/json_reference/ Fixes devcontainers#1054
Contributor
Author
|
@microsoft-github-policy-service agree |
fechu
added a commit
to fechu/zed
that referenced
this pull request
Apr 9, 2026
The devcontainer CLI writes the `devcontainer.metadata` container label as a bare JSON object when there is only one metadata entry (e.g. docker-compose with a Dockerfile and no features). This causes deserialization to fail because the current code only accepts a JSON array. Try parsing as an array first, then fall back to parsing as a single object wrapped in a vec. Upstream CLI fix: devcontainers/cli#1199 Related CLI issue: devcontainers/cli#1054
Merged
5 tasks
abdurriq
approved these changes
Apr 10, 2026
Contributor
|
Thank you for fixing this! |
KyleBarton
pushed a commit
to zed-industries/zed
that referenced
this pull request
Apr 10, 2026
…rray (#53557) Self-Review Checklist: - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable ## Details - The [devcontainer CLI writes the `devcontainer.metadata` label as a bare JSON object](devcontainers/cli#1054) when there is only one metadata entry (e.g. docker-compose devcontainer with a Dockerfile and no features) - Zed's `deserialize_metadata` only accepted a JSON array, causing deserialization to fail with `invalid type: map, expected a sequence` - This made it impossible to attach to existing docker-compose devcontainers created by the devcontainer CLI or VS Code The fix tries parsing as an array first, then falls back to parsing as a single object wrapped in a vec. This mirrors how the [devcontainer CLI itself reads the label](https://github.com/devcontainers/cli/blob/main/src/spec-node/imageMetadata.ts#L476-L493). An upstream fix has also been submitted: devcontainers/cli#1199 ## Reproduction 1. Create a docker-compose devcontainer with a Dockerfile and no features: `.devcontainer/devcontainer.json`: ```json { "name": "repro", "dockerComposeFile": "docker-compose.yml", "service": "app", "remoteUser": "root" } ``` `.devcontainer/docker-compose.yml`: ```yaml services: app: build: context: . dockerfile: Dockerfile command: sleep infinity volumes: - ..:/workspace ``` `.devcontainer/Dockerfile`: ```dockerfile FROM ubuntu:24.04 ``` 2. `devcontainer up --workspace-folder .` 3. Open the folder in Zed, fails with metadata deserialization error Release Notes: - Fixed attaching to a devcontainer that has a single metadata element which was started with `devcontainer-cli`
piper-of-dawn
pushed a commit
to piper-of-dawn/zed
that referenced
this pull request
Apr 25, 2026
…rray (zed-industries#53557) Self-Review Checklist: - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable ## Details - The [devcontainer CLI writes the `devcontainer.metadata` label as a bare JSON object](devcontainers/cli#1054) when there is only one metadata entry (e.g. docker-compose devcontainer with a Dockerfile and no features) - Zed's `deserialize_metadata` only accepted a JSON array, causing deserialization to fail with `invalid type: map, expected a sequence` - This made it impossible to attach to existing docker-compose devcontainers created by the devcontainer CLI or VS Code The fix tries parsing as an array first, then falls back to parsing as a single object wrapped in a vec. This mirrors how the [devcontainer CLI itself reads the label](https://github.com/devcontainers/cli/blob/main/src/spec-node/imageMetadata.ts#L476-L493). An upstream fix has also been submitted: devcontainers/cli#1199 ## Reproduction 1. Create a docker-compose devcontainer with a Dockerfile and no features: `.devcontainer/devcontainer.json`: ```json { "name": "repro", "dockerComposeFile": "docker-compose.yml", "service": "app", "remoteUser": "root" } ``` `.devcontainer/docker-compose.yml`: ```yaml services: app: build: context: . dockerfile: Dockerfile command: sleep infinity volumes: - ..:/workspace ``` `.devcontainer/Dockerfile`: ```dockerfile FROM ubuntu:24.04 ``` 2. `devcontainer up --workspace-folder .` 3. Open the folder in Zed, fails with metadata deserialization error Release Notes: - Fixed attaching to a devcontainer that has a single metadata element which was started with `devcontainer-cli`
8 tasks
pofallon
added a commit
to get2knowio/deacon
that referenced
this pull request
May 25, 2026
Per devcontainers/cli#1199 (v0.86.0), the `devcontainer.metadata` image label is always a JSON array of partial-config entries, even when only a single entry is present. VS Code, Zed, and envbuilder iterate the array and merge entries in order. Writers that emit a single object break this contract. Writer changes (three sites): - crates/core/src/build/metadata.rs: DevcontainerMetadata::to_json now wraps in [...]. from_json returns Vec<Self> and accepts either form for backwards compatibility with images built by older Deacon versions. - crates/deacon/src/commands/build/mod.rs (image-reference path, ~L1272): the inline {name, image} label wrapped in [...]. - crates/deacon/src/commands/build/mod.rs (docker build path, ~L1546): the inline {configHash} label wrapped in [...]. Reader change: - crates/deacon/src/commands/read_configuration.rs (compute_merged_ configuration, ~L411): parses the label as Value, normalizes to a Vec of entries (array as-is; object wrapped in single-element vec), then deserializes each entry as a partial DevContainerConfig, applies variable substitution, and merges with the base config in declaration order. Behavior for upstream-built images (array form) is now correct; behavior for legacy Deacon-built images (object form) is preserved. Tests added (crates/core/src/build/metadata.rs): - test_to_json_emits_array: asserts label starts with '[' - test_from_json_handles_legacy_object_form: legacy single-object fixture - test_from_json_handles_array_form_with_multiple_entries: spec-form fixture - test_metadata_roundtrip: updated for new Vec return type - test_merge_labels_emits_array_label_value: end-to-end label assertion Verified locally: cargo fmt --check, cargo check, cargo clippy -D warnings, cargo nextest run --profile dev-fast --no-default-features (1930/1930 ok), cargo test --doc --workspace (130/130 ok), 38/38 merged-configuration adjacent tests pass. Known follow-up (not blocking 1.0; separate ticket): the DevcontainerMetadata struct wraps the config under a `config` subkey alongside features/ customizations/lockfile_hash. Upstream array entries are FLAT partial-config shapes. Deacon-emitted entries today are not directly merge-able as DevContainerConfig (latent issue pre-dating this PR). Flattening the struct to match upstream array-entry shape would be its own refactor. Refs: docs/ROADMAP_TO_1.0.md Tier 1 item "devcontainer.metadata label JSON array (CLI parity B.2)". Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
pofallon
added a commit
to get2knowio/deacon
that referenced
this pull request
May 25, 2026
Per devcontainers/cli#1199 (v0.86.0), the `devcontainer.metadata` image label is always a JSON array of partial-config entries, even when only a single entry is present. VS Code, Zed, and envbuilder iterate the array and merge entries in order. Writers that emit a single object break this contract. Writer changes (three sites): - crates/core/src/build/metadata.rs: DevcontainerMetadata::to_json now wraps in [...]. from_json returns Vec<Self> and accepts either form for backwards compatibility with images built by older Deacon versions. - crates/deacon/src/commands/build/mod.rs (image-reference path, ~L1272): the inline {name, image} label wrapped in [...]. - crates/deacon/src/commands/build/mod.rs (docker build path, ~L1546): the inline {configHash} label wrapped in [...]. Reader change: - crates/deacon/src/commands/read_configuration.rs (compute_merged_ configuration, ~L411): parses the label as Value, normalizes to a Vec of entries (array as-is; object wrapped in single-element vec), then deserializes each entry as a partial DevContainerConfig, applies variable substitution, and merges with the base config in declaration order. Behavior for upstream-built images (array form) is now correct; behavior for legacy Deacon-built images (object form) is preserved. Tests added (crates/core/src/build/metadata.rs): - test_to_json_emits_array: asserts label starts with '[' - test_from_json_handles_legacy_object_form: legacy single-object fixture - test_from_json_handles_array_form_with_multiple_entries: spec-form fixture - test_metadata_roundtrip: updated for new Vec return type - test_merge_labels_emits_array_label_value: end-to-end label assertion Verified locally: cargo fmt --check, cargo check, cargo clippy -D warnings, cargo nextest run --profile dev-fast --no-default-features (1930/1930 ok), cargo test --doc --workspace (130/130 ok), 38/38 merged-configuration adjacent tests pass. Known follow-up (not blocking 1.0; separate ticket): the DevcontainerMetadata struct wraps the config under a `config` subkey alongside features/ customizations/lockfile_hash. Upstream array entries are FLAT partial-config shapes. Deacon-emitted entries today are not directly merge-able as DevContainerConfig (latent issue pre-dating this PR). Flattening the struct to match upstream array-entry shape would be its own refactor. Refs: docs/ROADMAP_TO_1.0.md Tier 1 item "devcontainer.metadata label JSON array (CLI parity B.2)". Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
getDevcontainerMetadataLabelfunction wrote a bare JSON object when there was only one metadata entry (e.g. docker-compose devcontainer with no features), but an array when there were multiple entriesThe reading side (
internalGetImageMetadata0) already handles both formats, but the writing side was inconsistent. In this PR we propose to always write an array of objects for simplicity. For backwards compatibility we leave the parsing, which supports both. Changing this makes the code follow the robustness principle by being strict what is returned (always an array).Test instructions
Create the following project:
devcontainer.json:
docker-compose.yml:
Dockerfile
With the latest release the metadata is:
After this change:
Fixes #1054